MMA68xx_Diag.h

Go to the documentation of this file.

#ifndef _MMA68XX_DIAG_H
#define _MMA68XX_DIAG_H
 
/*
 **************************************************************
 * Defines, Macros and Typedefs 
 **************************************************************/
/*** Constant Macros ***/
/* Default Yes and No defines */
#ifndef TRUE
 #define TRUE (1u)
#endif
#ifndef CLEAR
 #define CLEAR (0u)
#endif
#ifndef BITS_IN_NIBBLE
 #define BITS_IN_NIBBLE (4u)
#endif
#ifndef BITS_IN_BYTE
 #define BITS_IN_BYTE (8u)
#endif
#ifndef BYTES_IN_16
 #define BYTES_IN_16  (2u)
#endif
#ifndef BYTES_IN_32
 #define BYTES_IN_32  (4u)
#endif
#ifndef BIT_DEFINITION
 #define BIT_DEFINITION
 #define BIT0  (1u << 0u)
 #define BIT1  (1u << 1u)
 #define BIT2  (1u << 2u)
 #define BIT3  (1u << 3u)
 #define BIT4  (1u << 4u)
 #define BIT5  (1u << 5u)
 #define BIT6  (1u << 6u)
 #define BIT7  (1u << 7u)
 #define BIT8  (1u << 8u)
 #define BIT9  (1u << 9u)
 #define BIT10 (1u << 10)
 #define BIT11 (1u << 11)
 #define BIT12 (1u << 12)
 #define BIT13 (1u << 13)
 #define BIT14 (1u << 14)
 #define BIT15 (1u << 15)
 #define BIT16 (1u << 16)
 #define BIT17 (1u << 17)
 #define BIT18 (1u << 18)
 #define BIT19 (1u << 19)
 #define BIT20 (1u << 20)
 #define BIT21 (1u << 21)
 #define BIT22 (1u << 22)
 #define BIT23 (1u << 23)
 #define BIT24 (1u << 24)
 #define BIT25 (1u << 25)
 #define BIT26 (1u << 26)
 #define BIT27 (1u << 27)
 #define BIT28 (1u << 28)
 #define BIT29 (1u << 29)
 #define BIT30 (1u << 30)
 #define BIT31 (1u << 31)
#endif

#define RAW_ACCEL_MODE      7u
#define OC_ACCEL_MODE       3u

/* Limits for CA tests */
#define CA_TEST_SAMPLES_AMOUNT        256u
#define CA_TEST_RAW_LIMIT_LO          1988u
#define CA_TEST_RAW_LIMIT_HI          2108u
#define CA_TEST_RAW_LIMIT_HYST        5u
#define CA_TEST_OC_LIMIT_LO           2047u /*-1LSB as Russ suggested instead of -0.25LSB in the spec*/
#define CA_TEST_OC_LIMIT_HI           2049u /*+1LSB as Russ suggested instead of +0.25LSB in the spec*/
#define CA_TEST_SELF_LIMIT_LO         442u
#define CA_TEST_SELF_LIMIT_HI         663u
#define CA_TEST_SELF_RAW_VS_OC_LIMIT  5u
#define CA_TEST_SELF_CROSS_AXIS_LIMIT 10u

/* Errors for tests */
#ifndef STATUS_CA_FAILED
#define STATUS_CA_FAILED                (BIT27 | BIT26)
#endif
#define STATUS_CA_RAW_X_FAILED          0x00000001
#define STATUS_CA_RAW_Y_FAILED          0x00000002
#define STATUS_CA_RAW_SELF_X_FAILED     0x00000004
#define STATUS_CA_RAW_SELF_Y_FAILED     0x00000008
#define STATUS_CA_RAW_HYST_X_FAILED     0x00000010
#define STATUS_CA_RAW_HYST_Y_FAILED     0x00000020
#define STATUS_CA_OC_X_FAILED           0x00000040
#define STATUS_CA_OC_Y_FAILED           0x00000080
#define STATUS_CA_OC_SELF_X_FAILED      0x00000100
#define STATUS_CA_OC_SELF_Y_FAILED      0x00000200
#define STATUS_CA_OC_HYST_X_FAILED      0x00000400
#define STATUS_CA_OC_HYST_Y_FAILED      0x00000800

/*** Function Macros ***/
#ifndef N_ELEMENTS
 #define N_ELEMENTS(X)           (sizeof(X)/sizeof(*(X)))
#endif

extern const uint16_t cau16MMA6800TestSettingsRaw[];
extern const uint16_t cau16MMA6800TestSettingsRawSelfX[];
extern const uint16_t cau16MMA6800TestSettingsRawSelfY[];
extern const uint16_t cau16MMA6800TestSettingsOC[];
extern const uint16_t cau16MMA6800TestSettingsOCSelfX[];
extern const uint16_t cau16MMA6800TestSettingsOCSelfY[];
extern const uint32_t cau32MMA6800ErrorCodeX[];
extern const uint32_t cau32MMA6800ErrorCodeY[];
extern const uint8_t cu8SizeofTestSettings;
extern const uint8_t cu8SizeofTestAmount;

/*
 ******************************************************************************
 *
 * Function:          u32fnMMA6800ReadAccelSum()
 *
 */
uint32_t u32fnMMA6800ReadAccelSum(const uint8_t u8Axis,
                                  const uint8_t u8AccelMode,
                                  uint32_t* pu32Destination,
                                  const uint8_t cu8Accel);
/*
 ******************************************************************************
 *
 * Function:          u32fnMMA6800ConfigTest()
 * 
 */
uint32_t u32fnMMA6800ConfigTest(uint32_t* pu32Destination,
                                const uint16_t* pu16DataToSend,
                                const uint8_t u8Size,
                                const uint8_t u8AccelMode,
                                const uint8_t u8Axis,
                                const uint8_t cu8Accel);
/*
 ******************************************************************************
 *
 * Function:          u32fnMMA6800PreSelfTest()
 *
 */
uint32_t u32fnMMA6800PreSelfTest(uint32_t* pu32Destination,
                                 const uint16_t* pu16DataToSend,
                                 const uint8_t u8Size,
                                 const uint8_t cu8AccelMode,
                                 const uint8_t cu8Axis,
                                 const uint16_t cu16LowLimit,
                                 const uint16_t cu16HighLimit,
                                 const uint32_t cu32StatusErrCode,
                                 const uint8_t cu8Accel);
/*
 ******************************************************************************
 *
 * Function:          u32fnMMA6800PowerOnSelfTest()
 *
 */
uint32_t u32fnMMA6800PowerOnSelfTest(uint32_t* pu32Destination,
                                     const uint16_t* pu16DataToSend,
                                     const uint16_t* pu16DataToSendCross,
                                     const uint8_t u8Size,                                     
                                     const uint8_t cu8AccelMode,
                                     const uint8_t cu8Axis,
                                     const uint32_t cu32StatusErrCode,
                                     const uint8_t cu8Accel);
/*
 ******************************************************************************
 *
 * Function:          u32fnMMA6800PostSelfTest()
 *
 */
uint32_t u32fnMMA6800PostSelfTest(uint32_t* pu32Destination,
                                  const uint16_t* pu16DataToSend,
                                  const uint8_t u8Size,                                  
                                  const uint8_t cu8AccelMode,
                                  const uint8_t cu8Axis,
                                  const uint32_t cu32StatusErrCode,
                                  const uint8_t cu8Accel);

#endif /* _FILENAME_H */